home *** CD-ROM | disk | FTP | other *** search
/ The Original Shareware 1.1 / The Original Shareware (WeMake CDs)(Volume 1.1)(CDs, Inc)(1993).iso / 16 / anarkey2.zip / ANARKED.DOC next >
Text File  |  1989-05-01  |  17KB  |  409 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                                     ANARKED
  10.                            The ANARKEY Keystroke Editor
  11.                                   User Manual
  12.  
  13.                                   Version 2.00
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                                 Steven Calwas
  37.                                Moderne Software
  38.                                 P.O. Box 3638
  39.                           Santa Clara, CA 95055-3638
  40.  
  41.  
  42.                               _______
  43.                          ____|__     |               (tm)
  44.                       --|       |    |-------------------
  45.                         |   ____|__  |  Association of
  46.                         |  |       |_|  Shareware
  47.                         |__|   o   |    Professionals
  48.                       -----|   |   |---------------------
  49.                            |___|___|    MEMBER
  50.  
  51.  
  52.  
  53.  
  54.                               Copyright (C) 1989
  55.                                by Steven Calwas
  56.                               All rights reserved
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.                                Introduction
  69.                                ------------
  70.  
  71.    ANARKED is the ANARKEY keystroke editor.  It allows ANARKEY functions
  72. to be reassigned to keystrokes other than their default assignments.  With
  73. ANARKED, you may configure ANARKEY to perform like your word processor,
  74. previous command-line editor, or own personal tastes.
  75.  
  76.    ANARKED is not a TSR (Terminate-and-Stay-Resident) program.  ANARKED
  77. modifies the ANARKEY.COM disk file so that it will recognize the new
  78. keystroke assignments.  ANARKEY does not have to be installed to run
  79. ANARKED.  ANARKED will patch the ANARKEY.COM disk file, not the resident
  80. program.  After running ANARKED, the new keystroke assignments will be
  81. activated the next time you install ANARKEY.
  82.  
  83.  
  84.  
  85.                               Getting Started
  86.                               ---------------
  87.  
  88.    Simply execute ANARKED from the DOS command line or from a batch file.
  89. ANARKED takes no command-line arguments, thus the syntax is simply:
  90.  
  91.         ANARKED
  92.  
  93.    When executed, ANARKED will ask for the name and location of the
  94. ANARKEY.COM program file you wish to configure.  In DOS versions 3.00 and
  95. later, the default input file is ANARKEY.COM located in the same directory
  96. and drive from which ANARKED was executed.  Earlier versions of DOS have a
  97. default input file of ANARKEY.COM in the current directory of the current
  98. drive.  Whichever version of DOS you're running, the default input filename
  99. will be displayed.  Pressing the <Enter> key will accept the default.  To
  100. specify a different filename or location, type the file's drive, path and
  101. name specification and then press <Enter>.
  102.  
  103.    ANARKED will check the input file to verify it is a valid ANARKEY program
  104. file.  ANARKED will modify ANARKEY versions 2.00 or greater.  Earlier
  105. versions of ANARKEY are not modifiable.  If the program file is found to be
  106. invalid, an error message will appear and ANARKED will prompt for another
  107. input file.
  108.  
  109.    Once a valid input file is specified, ANARKED will prompt for the output
  110. file.  Any changes you make during the ANARKED session will be stored in
  111. this output file.  By default, ANARKED will write the changes to the
  112. specified input file.  Pressing <Enter> will accept the default.  If you
  113. wish to save your changes to a different file, type in the desired file
  114. specification with optional drive and path.
  115.  
  116.    After specifying valid input and output files, ANARKED will display its
  117. main "command/keystroke window."
  118.  
  119.  
  120.  
  121.                       ANARKED Command/Keystroke Windows
  122.                       ---------------------------------
  123.  
  124.    A "command/keystroke window" is a full-screen window which contains a
  125. group of ANARKEY functions and their assigned keystrokes.  Since all of the
  126. ANARKEY functions cannot fit onscreen at once, they are divided into several
  127. windows.  Traversing through the windows is possible by pressing one of the
  128. action keys described below.
  129.  
  130.    Each ANARKEY function is displayed on a single line.  On each line is a
  131. function description and its keystroke invocations.  As displayed,
  132. keystrokes are surrounded by < > characters, for example <F1>.  These
  133. bracketing characters are not part of the keystroke invocation.  Any
  134. keystroke invocation that is not currently assigned is displayed as "<>".
  135.  
  136.    An ANARKEY function may have a maximum of two keystrokes assigned to it.
  137. For example, as shipped, the Find-History-Buffer-Match-and-Edit function is
  138. invoked by pressing either the <F5> or <Ctrl-K> keys.  Both of these
  139. keystrokes would share the line with the function description and would look
  140. something like this:
  141.  
  142.              Find match and edit      <F5>            <Ctrl-K>
  143.  
  144. The Active Keystroke Field
  145. --------------------------
  146.    One keystroke invocation in the window will be displayed in inverse
  147. video, meaning the characters are displayed on a bright background.  This
  148. keystroke is the "active keystroke field."  Keystroke assignments are always
  149. performed on the active keystroke field.
  150.  
  151. Action Keys
  152. -----------
  153.    There are seven "action" keys that, when pressed, cause ANARKED to
  154. perform a special operation.  The seven action keys are:
  155.  
  156.                 -- the arrow keys (Up, Down, Left and Right)
  157.                 -- <PgUp> and <PgDn>
  158.                 -- and <Esc>
  159.  
  160.    Pressing one of the arrow keys (Up, Down, Left or Right) will move the
  161. active keystroke field in the specified direction.  These keys are used to
  162. set the active field to any of the displayed keystroke invocations.
  163.  
  164.    All ANARKEY commands are modifiable with ANARKED, but, because they
  165. cannot all fit onscreen at once, commands are divided into several display
  166. windows.  Pressing the <PgUp> and <PgDn> keys will cycle through each of
  167. these windows.
  168.  
  169.    Pressing the <Esc> key will activate the "ANARKED Action Menu."  From the
  170. Action Menu you may perform special operations such as saving your changes,
  171. assigning one of the action keys to a function or quitting the program.
  172. Each Action Menu function is explained later in this manual.
  173.  
  174.  
  175.  
  176.                           Editing ANARKEY Keystrokes
  177.                           --------------------------
  178.  
  179. Assigning New Keystrokes
  180. ------------------------
  181.    Pressing any key (other than an action key) will immediately assign that
  182. key to the active keystroke field.  As an example, to assign <F1> to the
  183. active keystroke field, simply hit <F1>.
  184.  
  185.    This method makes it extremely easy to configure ANARKEY without the
  186. confusing configuration files or installation programs required by many word
  187. processors.
  188.  
  189.    Most of the keystroke combinations available on a keyboard may be
  190. assigned to an ANARKEY function.  These include:
  191.  
  192.                  <Alt>  -sequences, like <Alt-F1>  and <Alt-A>,
  193.                  <Ctrl> -sequences, like <Ctrl-F1> and <Ctrl-Z> and
  194.                  <Shift>-sequences, like <Shift-F1>.
  195.  
  196.    Some keys, however, are reserved by DOS for special handling, for
  197. example, <Ctrl-C> and <Ctrl-P>.  These DOS-reserved keystrokes may not be
  198. assigned to an ANARKEY function.  If you attempt such an assignment, ANARKED
  199. will refuse to carry out your request.
  200.  
  201.    Each particular keystroke may be assigned to a maximum of one ANARKEY
  202. function.  Obviously, it would not make sense to have <F1> assigned to two
  203. different functions.  If a key is assigned to the active keystroke field and
  204. that key is already assigned to another function, the original assignment is
  205. removed.  ANARKED will beep once to let you know that you are, in effect,
  206. moving the key from its former assignment to a new function.
  207.  
  208. Clearing Keystrokes
  209. -------------------
  210.    A particular keystroke invocation may be completely removed or cleared
  211. from a function by pressing the <Ctrl-@> key when the field is the active
  212. keystroke field.  Notice that you will have to hold down one of the <Shift>
  213. keys to enter a <Ctrl-@> keystroke.  In case you forget this field-clearing
  214. keystroke, the Action Menu (described below) can be used to perform the same
  215. operation.
  216.  
  217.    NOTE: The TOPS local area network will not correctly handle the <Ctrl-@>
  218. keystroke.  Either UNLOAD TOPS when running ANARKED or use the corresponding
  219. Action Menu operation to remove keystroke assignments.  TOPS may also
  220. interfere with the assignment of otherwise valid keystrokes.  If you have
  221. any problems assigning a particular key, UNLOAD TOPS and try again.
  222.  
  223. An Editing Example
  224. ------------------
  225.    As an example of editing a keystroke assignment, let's say you want to
  226. configure the Delete-to-End-of-Line function so it will be executed every
  227. time you press <F1>.
  228.  
  229.    First, use the <PgUp>/<PgDn> keys to display the window that contains the
  230. Delete-to-End-of-Line function.  Then use the arrow keys to move the active
  231. keystroke field to the key-field you wish to change.
  232.  
  233.    By default, Delete-to-End-of-Line is assigned the keys <Ctrl-End> and
  234. <Ctrl-Y>.  Since a function may be assigned a maximum of two keystrokes, the
  235. new <F1> assignment will have to replace one of these.  Decide which key to
  236. replace and make it the active field by using the arrow keys.
  237.  
  238.    Finally, press the <F1> key.  <F1> will be immediately assigned to the
  239. active keystroke field.  If <F1> had already been assigned to another
  240. function, ANARKED would have automatically removed it and beeped to tell you
  241. so.
  242.  
  243.    As another example, say you do not want any possibility of accidently
  244. invoking the Clear-History-Buffer function.  You can, in effect, remove this
  245. command from ANARKEY by clearing all keystrokes assigned to it via <Ctrl-@>.
  246.  
  247.    That's all there is to it!
  248.  
  249.  
  250.  
  251.                           The ANARKED Action Menu
  252.                           -----------------------
  253.  
  254.    Operations other than keystroke assignments are performed by choosing a
  255. selection from the Action Menu.  The Action Menu is activated by pressing
  256. the <Esc> key.  Once active, the Action Menu provides the abilities to:
  257.  
  258.                -- save your editing changes and quit ANARKED,
  259.                -- create a summary file of the ANARKEY
  260.                   functions and their assigned keystrokes,
  261.                -- assign one of the action keys to a function,
  262.                -- clear the active keystroke field and
  263.                -- quit ANARKED without saving your changes.
  264.  
  265.    The Action Menu's active operation is displayed in inverse video.
  266. Pressing the Up and Down arrow keys will cycle the active operation through
  267. the available choices.  Pressing <Enter> will execute the active operation.
  268. Some operations are executed immediately, while others require additional
  269. input before executing.  If additional input is required, ANARKED will
  270. prompt you for it.  To exit the Action Menu, press <Esc>.
  271.  
  272.    Each Action Menu operation is explained below.
  273.  
  274. --- Save changes and quit
  275. -------------------------
  276.    This operation saves the current keystroke configuration to the output
  277. file specified during startup.  Since ANARKED modifies the ANARKEY.COM disk
  278. file, the new keystroke assignments will not take effect until the next time
  279. ANARKEY is installed.
  280.  
  281.    After writing the output file, ANARKED terminates and you are returned to
  282. the DOS command prompt.
  283.  
  284. --- Create summary list
  285. -----------------------
  286.    Executing this menu option will create a summary listing of ANARKEY
  287. functions and their current keystroke assignments.  The listing may be saved
  288. to a disk file or sent directly to a printer for use as a quick and handy
  289. reference when first learning ANARKEY.  You will be prompted for the
  290. summary's destination.
  291.  
  292.    To save the summary to a disk file, you may accept the displayed default
  293. destination or enter a different file specification with optional drive and
  294. path.  The default file spec will be the same as the output file you
  295. specified at ANARKED startup, but with a ".SUM" extension.  For example, if
  296. you specified the output file to be:
  297.  
  298.                         C:\BIN\ANARKEY.COM
  299.  
  300. then the default summary file will be:
  301.  
  302.                         C:\BIN\ANARKEY.SUM
  303.  
  304.    To accept the default, simply press <Enter> when prompted for the
  305. destination.
  306.  
  307.    To send the summary information to a printer, enter "PRN" when prompted
  308. for the destination.  The printer must be on-line and active BEFORE sending
  309. anything to it.  Check and be sure this is the case before you attempt to
  310. print or you may lose your current editing session.
  311.  
  312.    Pressing <F1> will abort the operation without creating a summary list.
  313.  
  314.    Tip: By defining an AKA that loads the summary file into your favorite
  315. word processor or file-viewing program, an on-line help facility can be
  316. created.  For example:
  317.  
  318.                     :help   editor c:\bin\anarkey.sum
  319.  
  320. --- Assign action key
  321. ---------------------
  322.    The seven action keys (Up, Down, Left and Right arrow keys, <PgUp>,
  323. <PgDn> and <Esc>) are used to execute special ANARKED operations.  To assign
  324. one of these keys to an ANARKEY function requires going through this Action
  325. Menu option.
  326.  
  327.    When this operation is chosen from the Action Menu, the next keystroke
  328. will be directly assigned to the active keystroke field.  The keystroke will
  329. not be interpreted by ANARKED.  Thus, pressing one of the action keys will
  330. assign that key to the active field.  If the key was already assigned to a
  331. function, ANARKED will beep to inform you it is removing the previous
  332. assignment.
  333.  
  334.    Although this method is mainly used to assign one of the action keys, any
  335. keystroke (except <F1>) will be assigned to the active keystroke field.
  336.  
  337.    Pressing <F1> will abort the operation without performing a keystroke
  338. assignment.
  339.  
  340. --- Remove keystroke (<Ctrl-@>)
  341. -------------------------------
  342.    When this operation is chosen, the active keystroke field is cleared of
  343. the keystroke currently assigned to it.
  344.  
  345.    This operation is equivalent to pressing <Ctrl-@> in a command/keystroke
  346. window.  The Action Menu operation is provided in case you forget <Ctrl-@>
  347. or if <Ctrl-@> is too difficult or not possible to enter.
  348.  
  349. --- Quit ANARKED without save
  350. -----------------------------
  351.    ANARKED will terminate immediately without saving your editing changes to
  352. the output file.
  353.  
  354.  
  355.  
  356.                      All Keyboards are NOT Created Equal
  357.                      -----------------------------------
  358.  
  359.    ANARKED will recognize as many keystrokes as your system's hardware and
  360. firmware support.
  361.  
  362.    Some systems have enhanced keyboards containing <F11> and <F12> keys.
  363. Unfortunately, the system BIOS on many of these machines will not recognize
  364. the extra keys.  If the BIOS will not recognize a key then ANARKED will not
  365. recognize it either.
  366.  
  367.    If your keyboard has <F11> and <F12> keys and ANARKED does not recognize
  368. them, please do not assume there is a problem with ANARKED.  More likely the
  369. fault lies with your machine's BIOS.
  370.  
  371.    Also, because ANARKEY must work in conjunction with so many other
  372. programs, it must be extremely well-behaved.  This means it must get its
  373. keyboard input from a level far-removed from your system's hardware.  Other
  374. programs that do not need to be so well-behaved may be able to access
  375. hardware directly.  Thus, these programs may be able to recognize certain
  376. keystrokes, such as <F11>, that ANARKED cannot.  Again, the problem is not
  377. due to some lack in ANARKED, but rather to the circumstances in which it
  378. must operate.
  379.  
  380.    Please do not deluge me with bug reports about how ANARKED does not
  381. recognize certain keystrokes.  If you truly happen to come upon a common
  382. keystroke, for example, <Alt-F1>, that ANARKED does not accept, I would like
  383. to know.  But if you're pressing your <F11> and <F12> keys and nothing is
  384. happening, the problem lies elsewhere.
  385.  
  386.  
  387.  
  388.                            Comments and Suggestions
  389.                            ------------------------
  390.  
  391.    I would love to hear your suggestions, comments, and enhancement ideas
  392. concerning ANARKED and the other programs in the ANARKEY software package.
  393. Please send your suggestions to:
  394.  
  395.                                 Steven Calwas
  396.                                Moderne Software
  397.                                 P.O. Box 3638
  398.                           Santa Clara, CA 95055-3638
  399.  
  400.                               _______
  401.                          ____|__     |               (tm)
  402.                       --|       |    |-------------------
  403.                         |   ____|__  |  Association of
  404.                         |  |       |_|  Shareware
  405.                         |__|   o   |    Professionals
  406.                       -----|   |   |---------------------
  407.                            |___|___|    MEMBER
  408.  
  409.